IRIX Base Documentation 2002 November/SGI IRIX Base Documentation 2002 November.iso/usr/share/catman/p_man/cat3/il_c/ilHwConnection.z/ilHwConnection

Text File | 2002-10-03 | 17.4 KB | 397 lines

iiiillllHHHHwwwwCCCCoooonnnnnnnneeeeccccttttiiiioooonnnn((((3333))))  IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll  iiiillllHHHHwwwwCCCCoooonnnnnnnneeeeccccttttiiiioooonnnn((((3333))))



NNNNAAAAMMMMEEEE
     iiiillllHHHHwwwwCCCCoooonnnnnnnneeeeccccttttiiiioooonnnn - X server connection

IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
     This is a base class

HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
     #include <il/ilCdefs.h>


CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
     ilHwConnection manages IL's private server connections, it is essentially
     a cache of shadow connections (to avoid redundant Display's) and also
     maintains a list of OpenGL contexts that have been created on each
     connection.

     The ilHwConnection also provides information on each display's
     capabilities (including whether or not OpenGL is supported and what
     operations are really done in hardware).

     Provision is also made for creation and caching of X colormaps for use
     with various visuals on each connection.

CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
     GGGGeeeetttt////sssseeeetttt mmmmeeeetttthhhhooooddddssss

          Display* ilHwConnectionGetDisplay(ilHwConnection *obj)
          void ilHwConnectionGetScreenSize(ilHwConnection *obj,
                                           iflXYint* size)
          int ilHwConnectionGetCapability(ilHwConnection *obj)
          int ilHwConnectionHasCapability(ilHwConnection *obj, int cap)
          int ilHwConnectionGetExtension(ilHwConnection *obj)
          int ilHwConnectionHasExtension(ilHwConnection *obj, int ext)
          int ilHwConnectionGetSupportedTypes(ilHwConnection *obj)
          int ilHwConnectionGetSupportedOrders(ilHwConnection *obj)
          int ilHwConnectionSupportsType(ilHwConnection *obj, iflDataType type)
          int ilHwConnectionSupportsOrder(ilHwConnection *obj, iflOrder order)
          int ilHwConnectionIsDirect(ilHwConnection *obj)
          Colormap ilHwConnectionGetDefaultColormap(ilHwConnection *obj,
                                                    VisualID id)
          ilFrameBufferImg* ilHwConnectionGetDummyFbImg(ilHwConnection *obj)
          int ilHwConnectionFindVisualByAttr(ilHwConnection *obj,
                                             ilHwVisual* vis,
                                             int attr, int minSize,
                                             int maxSize)
          int ilHwConnectionFindVisualByID(ilHwConnection *obj,
                                           ilHwVisual* vis, VisualID visualid)
          ilHwRenderer ilHwConnectionGetRenderer(ilHwConnection *obj)
          int ilHwConnectionGetConvolveMaxWidth(ilHwConnection *obj)
          int ilHwConnectionGetConvolveMaxHeight(ilHwConnection *obj)
          int ilHwConnectionGetSepConvolveMaxWidth(ilHwConnection *obj)
          int ilHwConnectionGetSepConvolveMaxHeight(ilHwConnection *obj)



                                                                        PPPPaaaaggggeeee 1111






iiiillllHHHHwwwwCCCCoooonnnnnnnneeeeccccttttiiiioooonnnn((((3333))))  IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll  iiiillllHHHHwwwwCCCCoooonnnnnnnneeeeccccttttiiiioooonnnn((((3333))))



          int ilHwConnectionGetLutMaxSize(ilHwConnection *obj)
          int ilHwConnectionGetFilter4Size(ilHwConnection *obj)
          void ilHwConnectionSetRenderingStyle(ilHwConnection *obj,
                                               ilRenderingStyle style)
          ilRenderingStyle ilHwConnectionGetRenderingStyle(ilHwConnection *obj)



FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
     ffffiiiinnnnddddVVVViiiissssuuuuaaaallllBBBByyyyAAAAttttttttrrrr(((())))

          int ilHwConnectionFindVisualByAttr(ilHwConnection *obj,
                                             ilHwVisual* vis,
                                             int attr, int minSize,
                                             int maxSize)


          This method fills in an ilHwVisual, _v_i_s, based on attributes
          specified in _a_t_t_r (see the enumerated type ilHwVisualAttributes in
          <il/ilHwConnection.h>), _m_i_n_S_i_z_e (minimum component size) and _m_a_x_S_i_z_e
          (maximum component size).

          The double-buffer, stereo and rgb attributes are just suggestions,
          not absolute requirments, if no visual is found with those
          attributes a lesser visual will be returned. The remaining
          attributes imply absolute requirements, no lesser visual will be
          returned.  The visual class fields restrict which visual classes
          will be considered, and are also absolute requirements.

     ffffiiiinnnnddddVVVViiiissssuuuuaaaallllBBBByyyyIIIIDDDD(((())))

          int ilHwConnectionFindVisualByID(ilHwConnection *obj,
                                           ilHwVisual* vis, VisualID visualid)


          This method fills in an ilHwVisual, _v_i_s, that matches the VisualID
          indicated by _v_i_s_u_a_l_i_d.

     ggggeeeettttCCCCaaaappppaaaabbbbiiiilllliiiittttyyyy(((())))

          int ilHwConnectionGetCapability(ilHwConnection *obj)


          This methods returns the rendering capabilities of this connection
          as defined by ilHwCapability in <il/ilHwConnection.h>.

     ggggeeeettttCCCCoooonnnnvvvvoooollllvvvveeeeMMMMaaaaxxxxHHHHeeeeiiiigggghhhhtttt(((())))

          int ilHwConnectionGetConvolveMaxHeight(ilHwConnection *obj)






                                                                        PPPPaaaaggggeeee 2222






iiiillllHHHHwwwwCCCCoooonnnnnnnneeeeccccttttiiiioooonnnn((((3333))))  IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll  iiiillllHHHHwwwwCCCCoooonnnnnnnneeeeccccttttiiiioooonnnn((((3333))))



          If the server supports the OpenGL convolution extension, then this
          method returns the maximum height of a general convolution kernel.
          Otherwise, the method returns zero.

     ggggeeeettttCCCCoooonnnnvvvvoooollllvvvveeeeMMMMaaaaxxxxWWWWiiiiddddtttthhhh(((())))

          int ilHwConnectionGetConvolveMaxWidth(ilHwConnection *obj)


          If the server supports the OpenGL convolution extension, then this
          method returns the maximum width of a general convolution kernel.
          Otherwise, the method returns zero.

     ggggeeeettttDDDDeeeeffffaaaauuuullllttttCCCCoooolllloooorrrrmmmmaaaapppp(((())))

          Colormap ilHwConnectionGetDefaultColormap(ilHwConnection *obj,
                                                    VisualID id)


          This method returns a colormap suitable for use with the visual
          indicated by _i_d.  The colormaps thus allocated are cached on this
          connection.

     ggggeeeettttDDDDiiiissssppppllllaaaayyyy(((())))

          Display* ilHwConnectionGetDisplay(ilHwConnection *obj)


          Returns the internal Display* for this connection;

     ggggeeeettttDDDDuuuummmmmmmmyyyyFFFFbbbbIIIImmmmgggg(((())))

          ilFrameBufferImg* ilHwConnectionGetDummyFbImg(ilHwConnection *obj)


          The IL maintains a dummy window that is used to perform accelerated
          statistics operations when no images are being displayed.  The
          window is unmapped and zero-sized.  This method returns the
          ilFrameBufferImg associated with this window.

     ggggeeeettttEEEExxxxtttteeeennnnssssiiiioooonnnn(((())))

          int ilHwConnectionGetExtension(ilHwConnection *obj)


          Query the OpenGL extensions supported by this connection.  The
          extensions are encoded in a bit mask.  The bits are defined in the
          ilHwExtension enum in <il/ilHwConnection.h>.

     ggggeeeettttFFFFiiiilllltttteeeerrrr4444SSSSiiiizzzzeeee(((())))





                                                                        PPPPaaaaggggeeee 3333






iiiillllHHHHwwwwCCCCoooonnnnnnnneeeeccccttttiiiioooonnnn((((3333))))  IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll  iiiillllHHHHwwwwCCCCoooonnnnnnnneeeeccccttttiiiioooonnnn((((3333))))



          int ilHwConnectionGetFilter4Size(ilHwConnection *obj)


          This method returns the size of the bicubic resampling filter
          expected by this connection.  (This value has meaning only if the
          server supports the OpenGL "filter4" extension.)

     ggggeeeettttLLLLuuuuttttMMMMaaaaxxxxSSSSiiiizzzzeeee(((())))

          int ilHwConnectionGetLutMaxSize(ilHwConnection *obj)


          This method returns the maximum size of a color table accepted by
          this connection.

     ggggeeeettttRRRReeeennnnddddeeeerrrreeeerrrr(((())))

          ilHwRenderer ilHwConnectionGetRenderer(ilHwConnection *obj)


          Returns the type of graphics device associated with this connection.
          The result can be one of the following enums:

          enum ilHwRenderer {
              ilHwRendIR,             // InfiniteReality
              ilHwRendRE,             // RealityEngine
              ilHwRendImpact,         // Impact
              ilHwRendNewport,        // Newport Graphics (Indy/Indigo2)
              ilHwRendIndigo,         // Indigo Entry, Indy[XL], XS, XZ, Elan, Extreme
              ilHwRendCrime,          // O2
              ilHwRendOther           // Unknown
          };


     ggggeeeettttRRRReeeennnnddddeeeerrrriiiinnnnggggSSSSttttyyyylllleeee(((())))

          ilRenderingStyle ilHwConnectionGetRenderingStyle(ilHwConnection *obj)


          Returns the default rendering style of either _i_l_O_p_e_n_G_L_R_e_n_d_e_r_i_n_g
          (default if OpenGL available) or _i_l_X_R_e_n_d_e_r_i_n_g for this connection.

     ggggeeeettttSSSSccccrrrreeeeeeeennnnSSSSiiiizzzzeeee(((())))

          void ilHwConnectionGetScreenSize(ilHwConnection *obj,
                                           iflXYint* size)


          Returns the screen resolution (in pixels).






                                                                        PPPPaaaaggggeeee 4444






iiiillllHHHHwwwwCCCCoooonnnnnnnneeeeccccttttiiiioooonnnn((((3333))))  IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll  iiiillllHHHHwwwwCCCCoooonnnnnnnneeeeccccttttiiiioooonnnn((((3333))))



     ggggeeeettttSSSSeeeeppppCCCCoooonnnnvvvvoooollllvvvveeeeMMMMaaaaxxxxHHHHeeeeiiiigggghhhhtttt(((())))

          int ilHwConnectionGetSepConvolveMaxHeight(ilHwConnection *obj)


          If the server supports the OpenGL convolution extension, then this
          method returns the maximum height of a seperable convolution kernel.
          Otherwise, the method returns zero.

     ggggeeeettttSSSSeeeeppppCCCCoooonnnnvvvvoooollllvvvveeeeMMMMaaaaxxxxWWWWiiiiddddtttthhhh(((())))

          int ilHwConnectionGetSepConvolveMaxWidth(ilHwConnection *obj)


          If the server supports the OpenGL convolution extension, then this
          method returns the maximum width of a seperable convolution kernel.
          Otherwise, the method returns zero.

     ggggeeeettttSSSSuuuuppppppppoooorrrrtttteeeeddddOOOOrrrrddddeeeerrrrssss(((())))

          int ilHwConnectionGetSupportedOrders(ilHwConnection *obj)


          This method returns a logical OR of the supported dimension orders
          (as defined by iflOrder) that OpenGL transfers on this connection
          can use.

     ggggeeeettttSSSSuuuuppppppppoooorrrrtttteeeeddddTTTTyyyyppppeeeessss(((())))

          int ilHwConnectionGetSupportedTypes(ilHwConnection *obj)


          This method returns a logical OR of the supported data types (as
          defined by iflDataType) that OpenGL transfers on this connection can
          use.

     hhhhaaaassssCCCCaaaappppaaaabbbbiiiilllliiiittttyyyy(((())))

          int ilHwConnectionHasCapability(ilHwConnection *obj, int cap)


          This methods tests for the presence of certain rendering
          capabilities, specified by _c_a_p, on this connection.  The possible
          values are defined by ilHwCapability in <il/ilHwConnection.h>.

     hhhhaaaassssEEEExxxxtttteeeennnnssssiiiioooonnnn(((())))

          int ilHwConnectionHasExtension(ilHwConnection *obj, int ext)







                                                                        PPPPaaaaggggeeee 5555






iiiillllHHHHwwwwCCCCoooonnnnnnnneeeeccccttttiiiioooonnnn((((3333))))  IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll  iiiillllHHHHwwwwCCCCoooonnnnnnnneeeeccccttttiiiioooonnnn((((3333))))



          Queries the connection for a particular extension by testing the bit
          fields returned by ggggeeeettttEEEExxxxtttteeeennnnssssiiiioooonnnn().  See ggggeeeettttEEEExxxxtttteeeennnnssssiiiioooonnnn().

     iiiissssDDDDiiiirrrreeeecccctttt(((())))

          int ilHwConnectionIsDirect(ilHwConnection *obj)


          Returns TRUE if this connection supports direct OpenGL contexts.

     sssseeeettttRRRReeeennnnddddeeeerrrriiiinnnnggggSSSSttttyyyylllleeee(((())))

          void ilHwConnectionSetRenderingStyle(ilHwConnection *obj,
                                               ilRenderingStyle style)


          Sets the default rendering style to either _i_l_O_p_e_n_G_L_R_e_n_d_e_r_i_n_g or
          _i_l_X_R_e_n_d_e_r_i_n_g for this connection.

     ssssuuuuppppppppoooorrrrttttssssOOOOrrrrddddeeeerrrr(((())))

          int ilHwConnectionSupportsOrder(ilHwConnection *obj, iflOrder order)


          This method returns true if the specified dimension order, _o_r_d_e_r,
          (as defined by iflOrder) is supported for OpenGL transfers on this
          connection.

     ssssuuuuppppppppoooorrrrttttssssTTTTyyyyppppeeee(((())))

          int ilHwConnectionSupportsType(ilHwConnection *obj, iflDataType type)


          This method returns true if the specified data type, _t_y_p_e, (as
          defined by iflDataType) is supported for OpenGL transfers on this
          connection.

SSSSEEEEEEEE AAAALLLLSSSSOOOO
     ilHwContext(3), ilHwVisual(3), <il/ilHwConnection.h>
















                                                                        PPPPaaaaggggeeee 6666